/**
 * @(#)RecursosMaterialesManagerK.java Mar 15, 2007
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : Psique
 * <br/>Creaci&oacute;n: Mar 15, 2007 - 5:55:37 PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <ul>
 * <li>Mar 15, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Psique</a> | Creaci&oacute;n del Objeto.</li>
 * <li>Abr 19, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Psique</a> | Se eliminar&oacute;n las referencias a las clases Empresa, Deportamento, etc y se cambiar&oacute;n por referencias a Estructura.</li>
 *
 * </ul>
 */

package com.psiqueware.jazmin.empresas.recursos.materiales.manager;

import com.psiqueware.alheli.exception.NullArgumentException;
import com.psiqueware.alheli.dao.DAOException;
import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.manager.BaseManager;
import com.psiqueware.alheli.manager.ManagerException;
import com.psiqueware.alheli.logging.Logger;
import com.psiqueware.alheli.logging.LoggerFactory;
import com.psiqueware.jazmin.empresas.recursos.materiales.RecursosMaterialesManager;
import com.psiqueware.jazmin.empresas.recursos.materiales.Ubicacion;
import com.psiqueware.jazmin.empresas.recursos.materiales.dao.RecursosMaterialesDAOFactory;
import com.psiqueware.jazmin.empresas.recursos.materiales.dao.UbicacionDAO;
import com.psiqueware.jazmin.empresas.recursos.materiales.modelo.UbicacionK;
import com.psiqueware.manzanilla.informacion.documentos.Documento;
import com.psiqueware.manzanilla.informacion.documentos.DocumentosManagerFactory;
import com.psiqueware.manzanilla.informacion.documentos.DocumentosManager;
import com.psiqueware.tulipan.ubicaciones.Direccion;
import com.psiqueware.tulipan.organizacional.Estructura;

import java.util.List;

/**
 * Encargado de las operaciones relacionadas a los recursos materiales.
 * <br/>Paquete Original: com.psiqueware.laVIE.empresas.recursos.materiales.manager
 * <br/>Nombre  Original: RecursosMaterialesManagerK
 * <br/>Oprima para ver : <a href="RecursosMaterialesManagerK.java.html"><i>C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Psique</a>
 * @version Revision: 1.1 Mar 15, 2007 5:55:37 PM
 * @noinspection ClassWithoutToString,DuplicateStringLiteralInspection
 */
public class RecursosMaterialesManagerK extends BaseManager implements RecursosMaterialesManager
{

    /** Logger de clase para RecursosMaterialesManagerK */
    private static final Logger s_log = LoggerFactory.getLogger ( RecursosMaterialesManagerK.class );

    /** Manager para crear documentos. */
    private DocumentosManager m_documentosManager = DocumentosManagerFactory.getDocumentosManager ();

    /** DAO de {@link Ubicacion}. */
    private static UbicacionDAO s_UbicacionDAO = RecursosMaterialesDAOFactory.findDAOUbicacion ();

    /** Constructor de RecursosMaterialesManagerK. */
    public RecursosMaterialesManagerK ()
    {
    }

    /**
     * Crea una nueva {@link Ubicacion } para la Empresa dada.
     *
     * @param estructura             Empresa cuya ubicaci&oacute;n se esta utilizando.
     * @param clave               de la {@link Ubicacion}.
     * @param enlaceTransaccional para asegurar la atomicidad de la transacci&oacute;n.
     * @param direccion           a la que apunta la {@link Ubicacion}; puede ser <code>null</code>.
     *
     * @return {@link Ubicacion} para la Empresa.
     *
     * @exception com.psiqueware.alheli.manager.ManagerException
     *             en caso de no poder completar la operaci&oacute;n.
     */
    public Ubicacion registrarUbicacion ( Estructura estructura, String clave, Direccion direccion, EnlaceTransaccional enlaceTransaccional ) throws ManagerException
    {
        try
        {
            if ( null == estructura ) throw new NullArgumentException( "<error>El argumento 'estructura' no puede ser NULL.</error>" );
            if ( null == estructura.getId () ) throw new IllegalArgumentException ( "<error>El argumento 'estructura' deb&iacute;a encontrarse previamente persistido.</error>" );
            if ( null == clave ) throw new NullArgumentException ( "<error>El argumento 'clave' no puede ser NULL.</error>" );
            if ( null != direccion && null == direccion.getId () ) throw new IllegalArgumentException ( "<error>El argumento 'direccion' deb&iacute;a encontrarse previamente persistido.</error>" );

            final Documento descripcion = m_documentosManager.nuevoDocumento ( enlaceTransaccional );
            UbicacionK oK = new UbicacionK ( clave, descripcion, direccion, estructura );

            s_UbicacionDAO.saveUbicacion ( oK, enlaceTransaccional );
            return oK;
        }
        catch ( Exception e )
        {
            final String error = "<error><msg>No se pudo localizar la estructura.</msg><parametros>" + estructura + "</parametros></error>";
            s_log.error ( error );
            s_log.error ( e );
            enlaceTransaccional.rollBack ();
            throw new ManagerException ( error, e );
        }
    }

    /**
     * Busca una {@link Ubicacion} a partir de su id.
     *
     * @param id                  de la {@link Ubicacion} buscada.
     * @param enlaceTransaccional para asegurar la atomicidad de la transacci&oacute;n.
     *
     * @return {@link Ubicacion} en caso de encontrarla; <code>null</code> en caso contrario.
     *
     * @exception com.psiqueware.alheli.manager.ManagerException
     *             en caso de no poder completar la operaci&oacute;n.
     */
    public Ubicacion buscarUbicacionPorId ( Long id, EnlaceTransaccional enlaceTransaccional ) throws ManagerException
    {
        try
        {
            return s_UbicacionDAO.findUbicacionPorId ( id, enlaceTransaccional );
        }
        catch ( DAOException e )
        {
            final String error = "<error><msg>No se pudo localizar la Ubicacion.</msg><parametros>" + id + "</parametros></error>";
            s_log.error ( error );
            s_log.error ( e );
            enlaceTransaccional.rollBack ();
            throw new ManagerException ( error, e );
        }
    }

    /**
     * Devuelve un listado de los {@link Ubicacion} que utiliza la Empresa.
     *
     * @param enlaceTransaccional para asegurar la atomicidad de la transacci&oacute;n.
     * @param estructura             cuya informaci&oacute;n se busca. Debe encontrarse persistida.
     *
     * @return una {@link List} con esos objetos; vac&iacute;a en caso de no encontrar ninguno.
     */
    public List<Ubicacion> listarUbicacion ( Estructura estructura, EnlaceTransaccional enlaceTransaccional ) throws ManagerException
    {
        try
        {
            return s_UbicacionDAO.listUbicacionPorEstructura ( estructura, enlaceTransaccional );
        }
        catch ( Exception e )
        {
            String error = "<error><msg>No se pudo realizar el listado.</msg><parametros>" + estructura + "</parametros></error>";
            s_log.error ( error );
            s_log.error ( e );
            throw new ManagerException ( error, e );
        }
    }

}

